package cn.iocoder.yudao.module.design.service.notes;

import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.module.design.controller.admin.notes.vo.NotesCreateReqVO;
import cn.iocoder.yudao.module.design.controller.admin.notes.vo.NotesExportReqVO;
import cn.iocoder.yudao.module.design.controller.admin.notes.vo.NotesPageReqVO;
import cn.iocoder.yudao.module.design.controller.admin.notes.vo.NotesUpdateReqVO;
import cn.iocoder.yudao.module.design.dal.dataobject.notes.NotesDO;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 项目笔记 Service 接口
 *
 * @author czw
 */
public interface NotesService {

    /**
     * 创建项目笔记
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createNotes(@Valid NotesCreateReqVO createReqVO);

    /**
     * 更新项目笔记
     *
     * @param updateReqVO 更新信息
     */
    void updateNotes(@Valid NotesUpdateReqVO updateReqVO);

    /**
     * 删除项目笔记
     *
     * @param id 编号
     */
    void deleteNotes(Long id);

    /**
     * 获得项目笔记
     *
     * @param id 编号
     * @return 项目笔记
     */
    NotesDO getNotes(Long id);

    /**
     * 获得项目笔记列表
     *
     * @param ids 编号
     * @return 项目笔记列表
     */
    List<NotesDO> getNotesList(Collection<Long> ids);

    /**
     * 获得项目笔记分页
     *
     * @param pageReqVO 分页查询
     * @return 项目笔记分页
     */
    PageResult<NotesDO> getNotesPage(NotesPageReqVO pageReqVO);

    /**
     * 获得项目笔记列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 项目笔记列表
     */
    List<NotesDO> getNotesList(NotesExportReqVO exportReqVO);

}
